home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / Libraries / C Internet Config / IC Resource ƒ / IC Headers ƒ / IC Component API Descriptions.h < prev    next >
Encoding:
Text File  |  1995-11-17  |  22.2 KB  |  98 lines  |  [TEXT/SPM ]
  1. ust not be the empty string.
  2.     Returns icPrefNotFoundErr if no suitable entry is found.
  3. */
  4.  
  5. pascal ICError ICCMapTypeCreator(internetConfigurationComponent inst, OSType fType, OSType fCreator,
  6.         ConstStr255Param filename, ICMapEntry *entry)
  7. /*
  8.     Requires IC 1.1.
  9.     
  10.     You must specify a configuration before calling this routine.
  11.     You must be inside an ICBegin/End pair to call this routine.
  12.     Takes the type and creator (and optionally the name) of an outgoing
  13.     file and returns the most appropriate mappings database entry.
  14.     The filename may be either the name of the outgoing file or
  15.     the empty string.
  16.     Returns icPrefNotFoundErr if no suitable entry found.
  17. */
  18.  
  19. /* ----- Mid Level Routines ----- */
  20.  
  21. pascal ICError ICCMapEntriesFilename(internetConfigurationComponent inst, Handle entries, ConstStr255Param filename,
  22.         ICMapEntry *entry)
  23. /*
  24.     Requires IC 1.1.
  25.     
  26.     You must specify a configuration before calling this routine.
  27.     You do not have to be inside an ICBegin/End pair to call this routine.
  28.     Takes the name of an incoming file and returns the most appropriate
  29.     mappings database entry, based on its extension.
  30.     entries must be a handle to a valid IC mappings database preference.
  31.     filename must not be the empty string.
  32.     Returns icPrefNotFoundErr if no suitable entry is found.
  33. */
  34.  
  35. pascal ICError ICCMapEntriesTypeCreator(internetConfigurationComponent inst, Handle entries, OSType fType, OSType fCreator,
  36.         ConstStr255Param filename, ICMapEntry *entry)
  37. /*
  38.     Requires IC 1.1.
  39.     
  40.     You must specify a configuration before calling this routine.
  41.     You do not have to be inside an ICBegin/End pair to call this routine.
  42.     Takes the type and creator (and optionally the name) of an outgoing
  43.     file and returns the most appropriate mappings database entry.
  44.     entries must be a handle to a valid IC mappings database preference.
  45.     The filename may be either the name of the outgoing file or
  46.     the empty string.
  47.     Returns icPrefNotFoundErr if no suitable entry found.
  48. */
  49.  
  50. /* ----- Low Level Routines ----- */
  51.  
  52. pascal ICError ICCCountMapEntries(internetConfigurationComponent inst, Handle entries, long *count)
  53. /*
  54.     Requires IC 1.1.
  55.     
  56.     You must specify a configuration before calling this routine.
  57.     You do not have to be inside an ICBegin/End pair to call this routine.
  58.     Counts the number of entries in the mappings database.
  59.     entries must be a handle to a valid IC mappings database preference.
  60.     count is set to the number of entries.
  61. */
  62.  
  63. pascal ICError ICCGetIndMapEntry(internetConfigurationComponent inst, Handle entries, long ndx, long *pos, ICMapEntry *entry)
  64. /*
  65.     Requires IC 1.1.
  66.     
  67.     You must specify a configuration before calling this routine.
  68.     You do not have to be inside an ICBegin/End pair to call this routine.
  69.     Gets the ndx'th entry in the mappings database.
  70.     entries must be a handle to a valid IC mappings database preference.
  71.     ndx must be in the range from 1 to the number of entries in the database.
  72.     The value of pos is ignored on input. pos is set to the position of
  73.     the ndx'th entry in the database and is suitable for passing back
  74.     into ICSetMapEntry.
  75.     Does not return any user data associated with the entry.
  76. */
  77.  
  78. pascal ICError ICCGetMapEntry(internetConfigurationComponent inst, Handle entries, long pos, ICMapEntry *entry)
  79. /*
  80.     Requires IC 1.1.
  81.     
  82.     You must specify a configuration before calling this routine.
  83.     You do not have to be inside an ICBegin/End pair to call this routine.
  84.     Returns the entry located at position pos in the mappings database.
  85.     entries must be a handle to a valid IC mappings database preference.
  86.     pos should be 0 to get the first entry. To get the subsequent entries, add
  87.     entry.total_size to pos and iterate.
  88.     Does not return any user data associated with the entry.
  89. */
  90.  
  91. pascal ICError ICCSetMapEntry(internetConfigurationComponent inst, Handle entries, long pos, ICMapEntry *entry)
  92. /*
  93.     Requires IC 1.1.
  94.     
  95.     You must specify a configuration before calling this routine.
  96.     You do not have to be inside an ICBegin/End pair to call this routine.
  97.     Sets the entry located at position pos in the mappings database.
  98.     entries must be a handle to a valid IC mappings databa